home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1994 #2 / Monster Media No. 2 (Monster Media)(1994).ISO / maximus / max2tbbs.zip / TIFORMAT.DOC < prev    next >
Text File  |  1994-08-08  |  7KB  |  167 lines
  1.  
  2.                TBBS Userlog Importer: input file format
  3.  
  4.                           by Paul Blitz
  5.                            Version 1.00
  6.                              13/04/94
  7.  
  8.  
  9. General
  10. =======
  11.  
  12. The file used as the input to TUIMP is a simple comma delimited file, with a
  13. total maximum line length of 255 characters.
  14.  
  15. The first line of the input file is special: it contains a "version" for the
  16. file's format. Currently, this is "1.0". TUIMP checks this to make sure it
  17. can cope with the format.
  18.  
  19. All the other lines contain user data.
  20.  
  21. The input file does not include EVERY POSSIBLE piece of data, simply because
  22. many of them can be quite sensible zeroed (eg calls today).
  23.  
  24. To make things flexible, there is no limit on the length of the string items
  25. in the input file: however, those which are too long for TBBS will be simply
  26. truncated. (This point is worth noting in the case of the PASSWORD: many
  27. other BBS systems allow passwords of upto 16 characters, whilst TBBS only
  28. allows 8: as long as your users are made aware of this fact, then there will
  29. be few problems.
  30.  
  31. If TUIMP finds a tilde character ("~") in a string, this will be converted
  32. to a comma: this is the reverse effect of the "otherBBS exporting program".
  33. This was done as it is not possible to include a comma in comma-delimited
  34. data (which is obvious when you spend a moment to think about it).
  35.  
  36.  
  37. Field by field
  38. ==============
  39.  
  40. To make life easier, the line format is defined by the order in which the
  41. items are held in the TBBS userlog. Here's a list of all the items in the
  42. USERLOG.BBS file, with comments on whether they are imported (from the input
  43. file) set to sysop default, or zeroised.
  44.  
  45. Byte  Desc                                 Comment
  46. ----  ----                                 -------
  47. 0-49  First / Last name, Location          imported (48 chars max)
  48. 50    Password                             imported (8 chars max)
  49. 58    User priviledge                      imported
  50. 59    A1 flags                             imported (as a decimal number)
  51. 60    A2 flags                             imported(as a decimal number)
  52. 61    Nulls needed                         imported
  53. 62    Config bits: LFs, Upper case,        ANSI / IBM imported, others set
  54.        Ansi, IBM.                           as sysop record
  55. 63    Terminal Width                       imported
  56. 64    CLS codes (1st three chars)          set as sysop record
  57. 67    Total Logons                         imported
  58. 69    User expert level                    set as sysop record
  59. 70    Last message read                    zeroised
  60. 72    Review flags                         zeroised
  61. 73    Per Call time limit                  set as sysop record
  62. 74    Last 10 logons                       (to be decided!)
  63. 124   SYFGS (1st 32)                       zeroised
  64. 128   A3 flags                             imported (as a decimal number)
  65. 129   A4 flags                             imported (as a decimal number)
  66. 130   CLS codes (last three chars)         set as sysop record
  67. 135   Total bytes downloaded               imported
  68. 139   Total bytes uploaded                 imported
  69. 143   Download daily limit                 set as sysop record
  70. 147   Daily calls limit                    set as sysop record
  71. 149   Daily time limit                     set as sysop record
  72. 151   Mins used today                      zeroised
  73. 153   Billing class 0 time limit           zeroised
  74. 156   Total logged on time                 imported
  75. 159   SYFGS (33-56)                        zeroised
  76. 162   Billing class 0 time remaining       zeroised
  77. 165   Bytes downloaded today               zeroised
  78. 169   -more- page length                   imported
  79. 170   Notes field                          imported
  80. 234   Netmail credit                       imported
  81. 236   Netmail debit                        imported
  82. 238   Invisible flag + reserved            zeroised
  83. 239   Upload protocol                      imported
  84. 240   Download protocol                    imported
  85. 241   SYFGS (57-64)                        zeroised
  86. 242   Message entry styles                 set as sysop record
  87. 243   Password changed date                zeroised
  88. 246   Canansi / pwd expired                zeroised
  89. 247   reserved                             zeroised
  90. 250   aged cubbyholed msgs                 zeroised, even for sysop
  91. 252   pointer to USERLOG.PTR               zeroised, even for sysop
  92. 256   Addr1, Addr2, City, State,           imported (121 chars max)
  93.        Zip, Phone, Country
  94.  
  95.  
  96. Here's an imaginary input line (split so you can see it)
  97.  
  98. Paul Blitz,Winchester_ Hants,PASSWORD,10,12,44,0,ANSI,IBM,80,87,32,16...
  99. ... ,2829312,277504,0,24,*the sysop*,100,22,1,1,,,,,,0962-885696,
  100.  
  101.  
  102. This all means:
  103.  
  104. First / Last name, Location          "Paul Blitz", from "Winchester, Hants"
  105. Password                             PASSWORD
  106. Priv Level                           200
  107. A1 flags                             12 = $0C = ....X.X.
  108. A2 flags                             44 = $2C = ..X.X.X.
  109. A3 flags                             0  = $00 = ........
  110. A4 flags                             0  = $00 = ........
  111. Nulls needed                         0
  112. Config bits: LFs, Upper case,        Ansi=Yes, IBM=Yes
  113.  Ansi, IBM.
  114. Terminal Width                       80
  115. Total Logons                         87
  116. Total bytes downloaded               2,829,312
  117. Total bytes uploaded                 277,504
  118. Total logged on time                 0
  119. -more- page length                   24
  120. Notes field                          *the sysop*
  121. Netmail credit                       100 cents
  122. Netmail debit                        22 cents
  123. Upload Protocol                      1 = zmodem (note 1)*
  124. Download Protocol                    1 = zmodem
  125. Addr1, Addr2, City, State,           Phone = 0962-885696, others blank.
  126.  Zip, Phone, Country
  127.  
  128. (*note 1:    0 = None (auto select each call)
  129.              1 = Prompted Ascii
  130.              2 = Ascii, Xon after c/r rcvd
  131.              3 = Ascii, Xon/off flow control
  132.              4 = Xmodem
  133.              5 = Xmodem-1k
  134.              6 = Ymodem (batch)
  135.              7 = Ymodem-g (batch)
  136.              8 = SEALink
  137.              9 = Kermit
  138.              A = SuperKermit (sliding Windows)
  139.              B = Zmodem)
  140.  
  141. You will see how the "_" in the location was changed back to a ",".
  142.  
  143. The "Total logged on time" is zero simply because the "exporting" BBS setup
  144. doesn't have this information, so puts in a zero instead.
  145.  
  146. The A3 and A4 flags were zero because the (imaginary) exporting BBS only
  147. supports 16 bit-flags.
  148.  
  149. The priv level, 200, equates to 20 times the defined priv ("sysop") on the
  150. "other" BBS... In this case, you will get a range of privs, 20, 40 60....
  151. The multiplaction factor depends on the "other" BBS, and is chosen to expand
  152. the range as much as possible, whilst keeping the maximum value under 255.
  153. For full details, read the exporting program details.
  154.  
  155. If the Upload or Download figure is > 2 gigabytes, then you're gonna see
  156. some strange figures, as I'm only using a signed 32 bit number for those
  157. values.... if it's THAT much of a problem, contact me!
  158.  
  159.  
  160. Modifications / Extra notes
  161. ---------------------------
  162. Rev 1.01 :
  163.  
  164. discovered that (a) the user name must be in CAPS; (b) the password should
  165. be NULL filled, not space filled.
  166.  
  167.